@expo/config-types

What is @expo/config-types?

The @expo/config-types package provides TypeScript definitions for Expo config (`app.json` / `app.config.js`). It allows developers to have type checking and auto-completion when working with Expo configuration files, ensuring that the configuration adheres to the expected structure and types defined by Expo.

What are @expo/config-types's main functionalities?

Type checking for app.json

This code sample demonstrates how to define an Expo app configuration with type checking. It ensures that the configuration object adheres to the structure and types expected by Expo, providing auto-completion and preventing common mistakes.

import { ExpoConfig } from '@expo/config-types';

const config: ExpoConfig = {
  name: 'My Expo App',
  slug: 'my-expo-app',
  version: '1.0.0',
  orientation: 'portrait',
  icon: './path/to/icon.png',
  splash: {
    image: './path/to/splash.png',
    resizeMode: 'contain',
    backgroundColor: '#ffffff'
  },
  updates: {
    fallbackToCacheTimeout: 0
  },
  assetBundlePatterns: ['**/*'],
  ios: {
    supportsTablet: true
  },
  android: {
    adaptiveIcon: {
      foregroundImage: './path/to/foreground.png',
      backgroundColor: '#FFFFFF'
    }
  }
};

Other packages similar to @expo/config-types

@types/react-native

While not directly related to Expo configuration, @types/react-native provides TypeScript definitions for React Native components and APIs. It serves a similar purpose in the context of React Native development by offering type checking and auto-completion, enhancing developer experience and code reliability.

typescript-json-schema

typescript-json-schema is a tool that generates JSON schemas from TypeScript types. It can be used to validate JSON data structures against TypeScript interfaces. In comparison, @expo/config-types specifically provides TypeScript definitions for Expo configuration, whereas typescript-json-schema is a more general tool for generating JSON schemas from any TypeScript types.

README

👋 Welcome to
@expo/config-types

Types for the Expo config object app.config.ts.

Usage

import { ExpoConfig } from '@expo/config-types';

export default (): ExpoConfig => {
  return {
    name: 'My App',
    slug: 'my-app',
  };
};

Contributing

This package is 100% generated using the versioned JSON schemas from the Expo server.

• yarn generate - uses the major version from the package.json.
• yarn generate --path ../../../universe/server/www/xdl-schemas/UNVERSIONED-schema.json - uses the latest version from your local directory.
• yarn generate 39 - uses the given version.
• yarn generate unversioned - uses the latest version.